-
Notifications
You must be signed in to change notification settings - Fork 7
[TOO-314] Tool documentation auto generation tool and replacing hardcode mdx for component based one #705
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…ode mdx for component based one
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
app/_components/toolkit-docs/components/AvailableToolsTable.tsx
Outdated
Show resolved
Hide resolved
app/_components/toolkit-docs/components/documentation-chunk-renderer.tsx
Show resolved
Hide resolved
app/_components/toolkit-docs/components/AvailableToolsTable.tsx
Outdated
Show resolved
Hide resolved
- Update layout.tsx with locale detection from pathname - Update globals.css with nextra-steps styling - Update robots.txt with AI Agent Resources comment - Keep gmail integration page from main
Resolve all merge conflicts: - Keep our scope-picker.tsx with PostHog tracking - Keep our not-found.tsx with Suspense boundary fix - Keep our package.json with toolkit scripts and mdx deps - Keep next-sitemap.config.js (deleted in main) - Merge globals.css (keyframes + nextra-steps styling) - Merge gitignore (our additions)
app/_components/toolkit-docs/components/documentation-chunk-renderer.tsx
Show resolved
Hide resolved
…y curser (yes, i wil blame him)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| list.push(toolkit); | ||
| } else { | ||
| grouped.set(category, [toolkit]); | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unreachable else branch in groupByCategory function
Low Severity
The else branch in the groupByCategory function is unreachable dead code. The function first checks if (!grouped.has(category)) and sets an empty array if the category doesn't exist. It then immediately retrieves the list with grouped.get(category). Since the category is guaranteed to exist after the first conditional, list will always be defined, making the else branch impossible to reach.


Note
Medium Risk
Medium risk because it adds new automation (GitHub Actions + a filesystem-writing sync script) and introduces new client-side MDX evaluation/caching and UI logic that could affect docs rendering/performance.
Overview
Adds a new automation path to regenerate toolkit JSON after Porter deploys and open a PR, including a new
.github/scripts/sync-toolkit-sidebar.ts(with tests/docs) that derives integrations_meta.tsxnavigation fromdata/toolkits/and design-system categories.Introduces a new component-based toolkit docs surface (
app/_components/toolkit-docs/*) including searchable/paginated tools tables, per-tool sections, dynamic code example generation, and MDX-driven documentation chunk injection with caching; updatesScopePickerto support controlled selection, pagination, secrets/scopes aggregation, and copy actions.Smaller updates: dashboard link URL/prefix normalization, use toolkit icon URLs instead of component lookup, and repo/editor ignore settings to reduce watcher load.
Written by Cursor Bugbot for commit 04aa22d. This will update automatically on new commits. Configure here.